Carbon


IconFamilyToIconSuite

Header: Icons.h Carbon status: Supported

Provides iconSuite data for a given icon family.

OSErr IconFamilyToIconSuite (
    IconFamilyHandle iconFamily, 
    IconSelectorValue whichIcons, 
    IconSuiteRef *iconSuite
);
iconFamily

A handle to an iconFamily data structure to use as a source for icon data. For more information on the IconFamily data structure, see 'icns'.

whichIcons

The depths and sizes of icons to extract from the IconFamily data structure. For a description of the possible values, see “Icon Selector Constants”.

iconSuite

On return, a pointer to the structure which contains icon data as specified in the iconFamily and whichIcons parameters. Icon Services returns NULL if no appropriate icon data is found.

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when IconServicesLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by IconServicesLib 8.5 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/18/2000)